ValidatedFloat
A validated float number. This field is a wrapper of floats that is both a java.util.function.Supplier and java.util.function.Consumer of type Float
Author
fzzyhmstrs
Since
0.1.0
Parameters
Float. the default value of this wrapper
Float. the maximum allowed value, inclusive
Float. the minimum allowed value, inclusive
Samples
import me.fzzyhmstrs.fzzy_config.validation.number.*
fun main() {
//sampleStart
//Example ValidatedFloat. Defaults to 2f, allowable range 3f to 1f. Uses a Slider widget
val validatedFloat = ValidatedFloat(2f, 3f, 1f)
//You can define the widget type of ValidatedFloat, either a Slider or a "textbox"
val textBoxFloat = ValidatedFloat(2f, 3f, 1f, ValidatedNumber.WidgetType.TEXTBOX)
//ValidatedFloat built with just a min and max. Uses the minimum value for the default. can use either a Slider or a "textbox" widget.
val minMaxFloat = ValidatedFloat(2f, 4f)
//Example unbounded ValidatedFloat. Can be any valid float value. Widget forced to "textbox" style
val unboundedFloat = ValidatedFloat(2f)
//Example validation-only Float (unless your default happens to be 0f)
val emptyFloat = ValidatedFloat()
//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
"_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
"my_mod.my_config.subSection.fieldName": "Very Important Setting",
"my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
"""
//sampleEnd
}Constructors
A validated float number with a default selected from the min of the allowable range.
an unbounded validated float number.
an unbounded validated float number with default of 0f.
Types
Functions
updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.
Copies the stored value and returns it.
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.
Provides this validations default value
Whether this Translatable has a valid description
Whether this Translatable has a valid translation
Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue
Maps this validation to a new convertible type.
wraps the provided values into a ValidatedList with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
wraps the provided values into a ValidatedSet with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)
translation key of this Translatable. the "name" in-game
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.